Unclear message if connect timeout is too small

stefanmarth commented 1 year ago

🔍 Before submitting the issue

[X] I have searched among the existing issues
[X] I am using a Python virtual environment

🐞 Description of the bug

calling osl = Optislang() returns RuntimeError: Cannot get optiSLang server port.

The problem is solved by setting the ini_timeout osl = Optislang(ini_timeout=60)

so the error message doesn't fit the problem.

📝 Steps to reproduce

reduce timeout

💻 Which operating system are you using?

Windows

📀 Which ANSYS version are you using?

23R1

🐍 Which Python version are you using?

3.10

📦 Installed packages

adodbapi==2.6.1.3
affine==2.3.0
aiofiles==0.8.0
aiohttp==3.8.1
aiosignal==1.2.0
aiosqlite==0.17.0
alabaster==0.7.12
alembic==1.7.5
algopy==0.5.7
altair==4.2.0
altair-data-server==0.4.1
altair-transform==0.2.0
altair-widgets==0.2.2
altgraph==0.17.2
amply==0.1.4
aniso8601==7.0.0
ansiwrap==0.8.4
ansys-optislang-core==0.3.0
ansys-templates==0.8.0
anyio==3.5.0
appdirs==1.4.4
argon2-cffi==21.3.0
argon2-cffi-bindings==21.2.0
arrow==1.2.1
asciitree==0.3.3
asgi-csrf==0.9
asgiref==3.4.1
asn1crypto==1.4.0
asteval==0.9.26
astor==0.8.1
astroid==2.9.3
astroML==1.0.1
astropy==4.3.1
async-generator==1.10
async-timeout==4.0.2
atomicwrites==1.4.0
attrs==21.4.0
autopep8==1.6.0
Babel==2.9.1
backcall==0.2.0
backports-abc==0.5
baresql==0.7.6
base58==2.1.1
bcrypt==3.2.0
beautifulsoup4==4.10.0
binaryornot==0.4.4
black==21.12b0
bleach==4.1.0
blinker==1.4
blis==0.7.5
blosc==1.10.6
bokeh==2.4.2
Bottleneck==1.3.2
bqplot==0.12.32
branca==0.4.2
brewer2mpl==1.4.1
Brotli==1.0.9
cachelib==0.5.0
cachetools==5.0.0
Cartopy==0.20.2
catalogue==2.0.6
certifi==2021.10.8
cffi==1.15.0
cftime==1.5.1.1
chardet==4.0.0
charset-normalizer==2.0.10
click==7.1.2
click-default-group==1.2.2
click-plugins==1.1.1
cligj==0.7.2
cloudpickle==2.0.0
clr-loader==0.1.7
clrmagic==0.0.1a2
colorama==0.4.4
colorcet==3.0.0
cookiecutter==2.1.1
coverage==6.2
cramjam==2.5.0
cryptography==35.0.0
csvs-to-sqlite==1.3
cvxopt==1.2.7
cvxpy==1.1.18
cx-Freeze==6.9
cx-Logging==3.0
cycler==0.11.0
cymem==2.0.6
Cython==0.29.26
cytoolz==0.11.0
dash==2.0.0
dash-bootstrap-components==1.4.1
dash-core-components==2.0.0
dash-html-components==2.0.0
dash-table==5.0.0
dash-uploader==0.6.0
dask==2022.1.0
dask-glm==0.2.0
dask-image==2021.12.0
dask-labextension==5.2.0
dask-ml==2021.11.30
dask-searchcv==0.2.0
databases==0.4.1
datasette==0.60
datasette-graphql==1.5
datashader==0.13.0
datashape==0.5.2
dateparser==1.1.0
db.py==0.5.4b1
debugpy==1.5.1
decorator==4.4.2
defusedxml==0.7.1
Deprecated==1.2.13
deprecation==2.1.0
descartes==1.1.0
diff-match-patch==20200713
distlib==0.3.4
distributed==2022.1.0
docopt==0.6.2
docrepr==0.1.1
docutils==0.17.1
doxypypy==0.8.8.6
ecos==2.0.10
emcee==3.1.1
entrypoints==0.3
et-xmlfile==1.1.0
fast-histogram==0.10
fastapi==0.71.0
fasteners==0.17.2
fastparquet==0.7.2
feather-format==0.4.1
filelock==3.4.2
Fiona==1.8.20
flake8==4.0.1
Flask==2.0.2
flask-accepts==0.18.4
Flask-Compress==1.10.1
Flask-Mail==0.9.1
flask-restx==0.5.1
Flask-Session==0.4.0
Flask-SQLAlchemy==2.5.1
flaskerize==0.14.0
flit==3.6.0
flit_core==3.6.0
folium==0.12.1
fonttools==4.28.5
formlayout==1.2.1a1
frozenlist==1.2.0
fs==2.4.14
fsspec==2022.1.0
future==0.18.2
fuzzywuzzy==0.18.0
GDAL==3.4.1
geographiclib==1.52
geopandas==0.10.2
geopy==2.2.0
geoviews==1.9.3
gitdb==4.0.9
GitPython==3.1.26
gmpy2==2.1.2
graphene==2.1.9
graphql-core==2.3.1
graphql-relay==2.0.1
great-expectations==0.13.41
greenlet==1.1.2
guidata==2.0.3
guiqwt==4.0.1
h11==0.12.0
h2==4.1.0
h5py==3.6.0
HeapDict==1.0.1
holoviews==1.14.7
hpack==4.0.0
html5lib==1.1
httpcore==0.14.5
httpie==2.6.0
httpx==0.21.3
hupper==1.10.3
husl==4.0.3
hvplot==0.7.3
hypercorn==0.13.2
hyperframe==6.0.1
hypothesis==6.35.0
idlex==1.22
idna==3.1
imageio==2.13.5
imageio-ffmpeg==0.4.2
imagesize==1.3.0
imbalanced-learn==0.9.0
importlib-metadata==4.10.1
inflection==0.5.1
iniconfig==1.1.1
intake==0.6.4
intervaltree==3.0.2
ipycanvas==0.10.2
ipykernel==6.7.0
ipyleaflet==0.14.0
ipympl==0.8.6
ipython==7.31.0
ipython-genutils==0.2.0
ipython-sql==0.4.1b1
ipywidgets==7.6.5
isort==5.10.1
itsdangerous==2.0.1
janus==1.0.0
jedi==0.18.1
jellyfish==0.9.0
Jinja2==3.0.3
jinja2-time==0.2.0
joblib==1.1.0
json5==0.9.6
jsonpatch==1.32
jsonpointer==2.2
jsonschema==4.4.0
julia==0.5.7
jupyter==1.0.0
jupyter-bokeh==3.0.4
jupyter-client==7.1.1
jupyter-console==6.4.0
jupyter-core==4.9.1
jupyter-lsp==1.5.1
jupyter-packaging==0.11.1
jupyter-server==1.13.4
jupyter-server-mathjax==0.2.3
jupyter-server-proxy==3.2.0
jupyter-sphinx==0.3.2
jupyterlab==3.2.8
jupyterlab-git==0.34.2
jupyterlab-launcher==0.13.1
jupyterlab-lsp==3.10.0
jupyterlab-pygments==0.1.2
jupyterlab-server==2.10.3
jupyterlab-widgets==1.0.2
keyring==23.5.0
kiwisolver==1.3.2
langcodes==3.3.0
lazy-object-proxy==1.7.1
llvmlite==0.38.0
lmfit==1.0.3
locket==0.2.1
loky==3.0.0
lxml==4.7.1
lz4==3.1.10
Mako==1.1.6
Markdown==3.3.6
MarkupSafe==2.0.1
marshmallow==3.12.1
matplotlib==3.5.1
matplotlib-inline==0.1.3
maturin==0.12.6
mccabe==0.6.1
mercantile==1.2.1
mergedeep==1.3.4
metakernel==0.28.2
mistune==0.8.4
mizani==0.7.3
mkl-service==2.4.0
moviepy==1.0.3
mpl-scatter-density==0.7
mpld3==0.5.7
mpldatacursor==0.7.1
mpmath==1.2.1
msgpack==1.0.3
msvc-runtime==14.29.30133
multidict==5.2.0
multipledispatch==0.6.0
munch==2.5.0
murmurhash==1.0.6
mypy==0.931
mypy-extensions==0.4.3
mysql-connector-python==8.0.21
nbclassic==0.3.5
nbclient==0.5.10
nbconvert==6.4.0
nbconvert_reportlab==0.2
nbdime==3.1.1
nbformat==5.1.3
nbval==0.9.6
nest-asyncio==1.5.4
netCDF4==1.5.8
networkx==2.6.4a0
NLopt==2.7.0
nltk==3.6.7
notebook==6.4.7
numba==0.55.0
numcodecs==0.9.1
numdifftools==0.9.40
numexpr==2.8.1
numpy==1.21.5+mkl
numpydoc==1.1.0
oct2py==5.4.2
octave-kernel==0.34.0
openpyxl==3.0.9
orjson==3.6.5
osqp==0.6.2.post4
outcome==1.1.0
packaging==21.3
palettable==3.3.0
pandas==1.4.0
pandas-datareader==0.10.0
pandocfilters==1.5.0
panel==0.12.6
papermill==2.3.3
param==1.12.0
parambokeh==0.2.3
paramiko==2.8.0
paramnb==2.0.4
parso==0.8.3
partd==1.2.0
pathspec==0.9.0
pathy==0.6.1
patsy==0.5.2
pdfrw==0.4.post2
pdvega==0.2.1.dev0
pefile==2021.9.3
pep8==1.7.1
pexpect==4.8.0
pg8000==1.23.0
pickleshare==0.7.5
Pillow==9.0.0
PIMS==0.5
Pint==0.18
pipdeptree==2.2.1
pkginfo==1.8.2
platformdirs==2.4.1
plotly==5.5.0
plotnine==0.8.0
pluggy==1.0.0
ply==3.11
portpicker==1.4.0
poyo==0.5.0
ppci==0.5.8
preshed==3.0.6
prettytable==3.0.0
priority==2.0.0
proglog==0.1.9
prometheus-client==0.12.0
promise==2.3
prompt-toolkit==3.0.24
protobuf==4.0.0rc1
psutil==5.9.0
ptpython==3.0.20
ptyprocess==0.7.0
PuLP==2.3
py==1.11.0
py-lru-cache==0.1.4
pyaml==20.4.0
pyarrow==6.0.1
PyAudio==0.2.11
pybars3==0.9.7
pybind11==2.9.0
pycodestyle==2.8.0
pycosat==0.6.3
pycparser==2.21
pyct==0.4.8
pydantic==1.8.2
pydeck==0.7.1
pydocstyle==6.1.1
pyepsg==0.4.0
pyerfa==2.0.0.1
pyflakes==2.4.0
pyflux==0.4.17
pygame==2.1.2
pygbm==0.1.0
Pygments==2.11.2
pyhdf==0.10.3
pyinstaller==4.8
pyinstaller-hooks-contrib==2021.5
pylint==2.12.2
pyls-spyder==0.4.0
pymc==2.3.8
PyMeta3==0.5.1
pymongo==4.0.1
PyNaCl==1.5.0
pynndescent==0.5.5
pyodbc==4.0.32
PyOpenGL==3.1.5
pypandoc==1.5
pyparsing==2.4.7
pyproj==3.3.0
pyqtgraph==0.12.3
pyrsistent==0.18.1
pyserial==3.5
pyshp==2.1.3
PySide2==5.15.2.1
PySocks==1.7.1
pystache==0.5.4
pytest==6.2.5
python-baseconv==1.2.2
python-dateutil==2.8.2
python-dotenv==0.19.2
python-hdf4==0.10.0+dummy
python-Levenshtein==0.12.2
python-lsp-black==1.0.1
python-lsp-jsonrpc==1.0.0
python-lsp-server==1.3.3
python-multipart==0.0.5
python-picard==0.7
python-slugify==5.0.2
python-snappy==0.6.0
pythonnet==3.0.0a1
PythonQwt==0.10.1
pytz==2021.3
pytz-deprecation-shim==0.1.0.post0
pyviz-comms==2.1.0
PyWavelets==1.2.0
pywin32==303
pywin32-ctypes==0.2.0
pywinpty==1.1.6
pywinusb==0.4.2
PyYAML==6.0
pyzmq==22.3.0
pyzo==4.12.0
pyzstd==0.15.1
QDarkStyle==3.0.2
qdldl==0.1.5.post0
qpsolvers==1.8.0
qstylizer==0.2.1
QtAwesome==1.1.1
qtconsole==5.2.2
QtPy==2.0.0
quadprog==0.1.8
quantecon==0.5.2
quart==0.16.2
rasterio==1.2.10
readme-renderer==32.0
redis==4.1.0
regex==2022.1.18
reportlab==3.6.5
requests==2.27.1
requests-toolbelt==0.9.1
rfc3986==1.5.0
rise==5.7.1
rope==0.22.0
Rtree==0.9.7
ruamel.yaml==0.17.20
ruamel.yaml.clib==0.2.6
Rx==1.6.1
scikit-fuzzy==0.4.1
scikit-image==0.19.1
scikit-learn==1.0.2
scikit-optimize==0.9.0
scilab2py==0.6.2
scipy==1.7.3
scramp==1.4.1
scs==3.1.0
seaborn==0.11.2
Send2Trash==1.8.0
Shapely==1.8.0
shiboken2==5.15.2.1
simpervisor==0.4
simplegeneric==0.8.1
simplejson==3.17.6
simpy==4.0.1
six==1.16.0
sklearn-contrib-lightning==0.6.1
slicerator==1.0.0
smart-open==5.2.1
smmap==5.0.0
snakeviz==2.1.0
sniffio==1.2.0
snowballstemmer==2.2.0
snuggs==1.4.7
sortedcontainers==2.4.0
sounddevice==0.4.4
soupsieve==2.3.1
spacy==3.2.1
spacy-legacy==3.0.8
spacy-loggers==1.0.1
Sphinx==4.4.0
sphinx-rtd-theme==1.0.0
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
spyder==5.2.2
spyder-kernels==2.2.1
SQLAlchemy==1.4.28
sqlite-bro==0.12.1
sqlite-fts4==1.0.1
sqlite-utils==3.22
sqlparse==0.4.2
srsly==2.4.2
starlette==0.17.1
statsmodels==0.13.1
streamlit==1.1.0
streamz==0.6.3
supersmoother==0.4
swifter==1.0.9
sympy==1.9
tables==3.7.0
tabulate==0.8.9
tblib==1.7.0
tenacity==8.0.1
termcolor==1.1.0
terminado==0.12.1
testpath==0.5.0
text-unidecode==1.3
textdistance==4.2.2
textwrap3==0.9.2
thinc==8.0.13
threadpoolctl==3.0.0
three-merge==0.1.1
thrift==0.15.0
tifffile==2021.11.2
tinycss2==1.1.1
toml==0.10.2
tomli==1.2.2
tomli_w==1.0.0
tomlkit==0.8.0
toolz==0.11.2
tornado==6.1
tqdm==4.62.3
traitlets==5.1.1
traittypes==0.2.1
trio==0.19.0
trio-asyncio==0.12.0
twine==3.7.1
twitter==1.19.2
typer==0.4.0
typing_extensions==4.0.1
tzdata==2021.5
tzlocal==4.1
ujson==5.1.0
uncertainties==3.1.6
urllib3==1.26.8
uvicorn==0.17.0
validators==0.18.2
vega==3.5.0
vega-datasets==0.9.0
virtualenv==20.13.0
voila==0.3.0
wasabi==0.9.0
wasmer==1.1.0
wasmer_compiler_cranelift==1.1.0
wasmer_compiler_singlepass==1.1.0
watchdog==2.1.5
wcwidth==0.2.5
webencodings==0.5.1
websocket-client==1.2.3
websockets==10.1
Werkzeug==2.0.2
widgetsnbextension==3.5.2
winpython==4.6.20220116
wordcloud==1.8.1
wrapt==1.13.3
wsproto==1.0.0
xarray==0.20.2
XlsxWriter==3.0.2
xlwings==0.24.7
yapf==0.32.0
yarl==1.7.2
zarr==2.10.2
zict==2.0.0
zipp==3.7.0

rfahlberg commented 1 year ago

This issue also applies if no license is available, or if optiSLang fails to start due to other reasons.

PanekOndrej commented 8 months ago

Regarding the RuntimeError("Cannot get the optiSLang server port."):

this one is raised because listener didn't get the port from server responses in given timeout
there are basically 2 cases:
- server didn't have enough time to start correctly
- server didn't start correctly (e. g. licensing error)

Regarding the licensing error, this one is currenly captured in warning level of log (stderr stream is redirected there)

e. g. WARNING - osl_process - optiSLang_2577280449168 - stream_reader - optiSLang Stderr: ERROR: ANSYS license error: Failed to create AnsLicContext [2]: Unknown LaaS data error: LaaS returned error (320) - Failed to check out Elastic license on Cloud License Server XXX : User XXX not included in list permitted to use Elastic Licensing..

Regarding the listener timeout in general, this is captured as well in warning level of log.

e .g. WARNING - osl_server - optiSLang_2822365231760 - __listen - Listener 94474d0b-2ca3-406e-aef6-920dbb9e2b00 listening timed out.

Not sure though, if we can safely determine why the server didn't send response with port, if it was insufficient timeout or another reason.

Some ideas: (A) Extend the message in RuntimeError to "Cannot get the optiSLang server port. Please check the license. If license is available try increasing the ini_timeout and/or loglevel parameter. See documentation for more details." (B) Check that license is available before starting osl as ansDArnold proposed. Is there any easy way, how to check the license beforehand? (C) Scan stderr for "ANSYS license error" and pass this to the main thread. (D) Check whether the process is running before raising RuntimeError and if not, modify this to "OptiSLang process is not running.".

rfahlberg commented 8 months ago

Hi @PanekOndrej, I'd suggest to monitor the osl process (smtng like option (D)), during startup. When the oSL process terminates, immediately leave the "wait for server port" loop and raise an "optiSLang process could not be started (ErrorCode: xyz)" error, with optiSLang StdErr messages attached. As for the (ErrorCode: xyz), there are a few known error codes, e.g. there is a specific one for missing license, I will check and get back to you.

ansys / pyoptislang